Inside Macintosh: QuickDraw GX Objects /

Chapter 6 - Transform Objects / Transform Objects Reference

Functions / Getting and Setting the Hit-Test Parameters

GXGetShapeHitTest

You can use the GXGetShapeHitTest function to retrieve the hit-test parameters of the transform object associated with a particular shape.

gxShapePart GXGetShapeHitTest(gxShape source, 
                              Fixed *tolerance);

source

A reference to the shape whose transform object contains the hit-test parameters you want to examine.

tolerance

A pointer to a Fixed value. On return, the value specifies the hit-test tolerance of the source shape's transform.

function result

The shape-parts mask of the source shape's transform.

DESCRIPTION

The GXGetShapeHitTest function returns the hit-test parameters from the transform object associated with the shape referenced by the source parameter. The shape-parts mask is returned as the function result and the hit-test tolerance is returned by the tolerance parameter.

Hit-test tolerance is specified in geometry units. You can specify nil for the tolerance parameter, in which case the hit-test tolerance is not returned.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil

SEE ALSO

For information about the hit-test parameters property, see "Hit-Test Parameters" beginning on page 6-11. To interpret the values in the shape-parts mask, see Table 6-1 on page 6-12.

To assign hit-test parameters to the transform associated with a specified shape, use the GXSetShapeHitTest function, described next.

To retrieve the hit-test parameters of a specified transform object, use the GXGetTransformHitTest function, described on page 6-78.